PATH  Mac OS 8 and 9 Developer Documentation > Human Interface Toolbox > Icon Services and Utilities
> Obtaining and Using Icons With Icon Services

   

FlushIconRefsByVolume

On a given volume, reclaims memory used by purgeable icons.

pascal OSErr FlushIconRefsByVolume(SInt16 vRefNum);

vRefNum
A value of type SInt16 specifying the volume whose icon cache is to be flushed.

function result
A result code. See Icon Services Result Codes for a description of possible return values.
DISCUSSION
Calling this function locks the bitmap data of all IconRefs with non-zero reference counts (that is, all IconRefs that are in use) on the volume. The Finder normally maintains a number of IconRefs with non-zero reference counts, so you should use the function FlushIconRefs instead of the FlushIconRefsByVolume function whenever feasible.

© 1999 Apple Computer, Inc. – (Last Updated 03 Dec 99)